dxp-ux

POST/ProductOrder, PATCH/billingAccount/id resources is used to turn On or Off e-bill entity.

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/productOrder
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id} Fixed integration
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id} towards Salesforce integration

URI PARAMS

Header

Request

Note If the customer need to enable paper bill (disable ebill), in the request productOrderItem.action need to be pass as add and if need to disable the paper bill(enable ebill) pass productOrderItem.action as delete

{
    "category": "RES",
    "@type": "ProductOrder",
    "note": [
        {
            "text": "NT",
            "@type": "OrderReasonCode"
        },
        {
            "text": "ECO",
            "@type": "CampaignCode"
        }
   ],
    "relatedParty": [
        {
            "id": "1901502677899",
            "name": "CARLEY BURKE",
            "@referredType": "Customer"
        }
    ],
     "billingAccount":
        {
            "id": "8211990010042406",
            "@type": "BillingAccount"
        },
    "productOrderItem": [
        {
            "id": "ZMPBI",
            "quantity": 1,
            "action": "add",
            "product": {
                "id": "ZMPBI",
                "isBundle": false,
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "ServiceType",
                        "valueType": "string",
                        "value": "NU"
                    }
                ]
            },
             "@type": "AddonProduct"
        }
    ],
    "orderCharacteristics": {
        "salesRepId": "54321"
    },
    "serviceAddress": {
        "addrNo": "00622000000001"
    }
}

Definitions

Each of the parameters is detailed.

Response

{
    "category": "RES",
    "@type": "ProductOrder",
    "note": [
        {
            "text": "NT",
            "@type": "OrderReasonCode"
        },
        {
            "text": "ECO",
            "@type": "CampaignCode"
        }
    ],
    "relatedParty": [
        {
            "id": "1901502677899",
            "name": "CARLEY BURKE",
            "@referredType": "Customer"
        }
    ],
    "billingAccount": {
        "id": "8211990010042406",
        "@type": "BillingAccount"
    },
    "productOrderItem": [
        {
            "id": "ZMPBI",
            "quantity": 1,
            "action": "add",
            "product": {
                "id": "ZMPBI",
                "isBundle": false,
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "ServiceType",
                        "valueType": "string",
                        "value": "NU"
                    }
                ]
            },
            "@type": "AddonProduct"
        }
    ],
    "orderCharacteristics": {
        "salesRepId": "54321"
    },
    "serviceAddress": {
        "addrNo": "00622000000001"
    },
    "state": "acknowledged"
}

PATCH/billingAccount/id

[ 200 ] FIXED

OK - updateBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.

Request

{
    "billStructure": {
        "presentationMedia": [
            {
                "name": "email"
            }
        ]
    }
}

Response

{
    "id": "8211990010042315",
    "state": "acknowledged",
    "billStructure": {
        "presentationMedia": [
            {
                "name": "email"
            }
        ]
    }
}

FIXED Definitions

Enable Ebill towards Salesforce PATCH: /billingAccount/id

URI PARAMS

Header

Request

curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/sit/dxp-ux/dxp-ux/v1/PR/billingAccount/23541002-23542358' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2gk' \
--header 'client_id: xxx' \
--header 'client_secret: yyy' \
--header 'Content-Type: application/json' \
--data-raw '{
    "relatedParty": [
        {
            "id": "12218008837",
            "@type": "msisdn"
        },
        {
            "@type": "CHANNEL",
            "name": "DIGITAL"
        }
    ],
    "billStructure": {
        "presentationMedia": [
            {
                "@type": "non-eBill"
            }
        ]
    }
}'

Definitions

relatedParty values

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - updateBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "status": 200,
    "description": "Request to update the Ebill Flag received"
}

Definitions

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to invalid OrderId of the customer.

{
    "errors": [
        {
            "code": 400,
            "message": "ERROR:INVALIDID",
            "description": "OrderId for the Customer does not exist 1200034465921019"
        }
    ]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The primary device not found in the backend system",
      "description" : "The requested operation failed because the primary device in the backend system could not be found."
    }
  ]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": "error description"
    }
  ]
}